/* =============================================================
 * Your Grandmother's guide to Algorithms
 * =============================================================
 *
 * Copyright (c) 2007, Saverio Miroddi
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the SaverioMiroddiSoftware nor the names of its 
 *       contributors may be used to endorse or promote products derived from 
 *       this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  
 * ---------------------------
 * SavAssert.java
 * ---------------------------
 *
 */
package utils;

import static java.lang.String.format;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.junit.Assert;

/**
 * Custom assertions, based on JUnit.
 * 
 * @author Saverio Miroddi
 */
@SuppressWarnings("unchecked")
public class SavAssert
{
	/**
	 * Compares the order of two elements. WOW!!!!!!!
	 */
	public enum Order 
	{ 
		CRESCENT {
			@Override
			public boolean areOrdered(Comparable left, Comparable right) 
			{
				return left.compareTo(right) <= 0;
			}
		}, 
		CRESCENT_STRICT {
			@Override
			public boolean areOrdered(Comparable left, Comparable right) 
			{
				return left.compareTo(right) < 0;
			}
		},
		DECRESCENT {
			@Override
			public boolean areOrdered(Comparable left, Comparable right) 
			{
				return left.compareTo(right) >= 0;
			}
		},
		DECRESCENT_STRICT {
			@Override
			public boolean areOrdered(Comparable left, Comparable right) 
			{
				return left.compareTo(right) > 0;
			}
		};

		public abstract boolean areOrdered(Comparable left, Comparable right);
	}

	public static void assertOrdered(Comparable[] sequence, Order order) 
	{
		for (int i = 0; i < sequence.length - 1; i++) { // watch out -1
			Comparable left = sequence[i];
			Comparable right = sequence[i + 1];
			if (! order.areOrdered(left, right)) {
				String msg = format("Not ordered[%s]: %s->%s", i, left, right); 
				Assert.fail(msg);
			}
		}
	}
	
	public static <T extends Comparable<T>> void assertOrdered(
			List<T> sequence, Order order)
	{
		for (int i = 0; i < sequence.size() - 1; i++) { // watch out -1
			T right = sequence.get(i + 1);
			T left = sequence.get(i);
			if (! order.areOrdered(left, right)) {
				String msg = format("Not ordered[%s]: %s->%s", i, left, right);
				System.err.println("ARR: " + sequence);
				Assert.fail(msg);
			}
		}
	}
	
	public static <T extends Comparable<T>> void assertEqualArraysUnord(
			T[] expected, T[] actual)
	{
		T[] expCopy = expected.clone();
		T[] actCopy = actual.clone();
		
		Arrays.sort(expCopy);
		Arrays.sort(actCopy);
		
		Assert.assertArrayEquals(expCopy, actCopy);
	}
	
	public static <T extends Comparable<T>> void assertEqualListsUnord(
			List<T> expected, List<T> actual)
	{
		List<T> expOrdered = getOrderedList(expected);
		List<T> actOrdered = getOrderedList(actual);
		
		Assert.assertEquals(expOrdered.size(), actOrdered.size());
		
		for (int i = 0; i < expOrdered.size(); i++) {
			T exp = expOrdered.get(i);
			T act = actOrdered.get(i);
			try {
				Assert.assertEquals(exp, act);
			}
			catch (AssertionError e) {
				System.err.println("EXP: " + expOrdered);
				System.err.println("ACT: " + actOrdered);
				throw e;
			}
		}
	}
	
	private static <T extends Comparable<T>> List<T> getOrderedList(
			List<T> list) 
	{
		List<T> ordered = new ArrayList();
		
		for (T t : list) {
			int position = Collections.binarySearch(ordered, t);
			if (position < 0) position = -(position + 1);
			ordered.add(position, t);
		}
		
		return ordered;
	}
}